<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">

<title>class Net::HTTPRequest - net: Ruby Standard Library Documentation</title>


<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>

<script src="../js/jquery-3.2.0.min.js"></script>

<script src="../js/vue.min.js"></script>
<script src="../js/js.cookie.min.js"></script>

<link href="../css/fonts.css" rel="stylesheet">
<link id='rdoccss' href="../css/rdoc.css" rel="stylesheet">
<link href="../css/carbon17.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../";
  var index_rel_prefix = "../";
  var darkModeCsseHref = "../css/rdoc-dm.css"
  var defaultModeCssHref = "../css/rdoc.css"
  // var cssDarkmode = Cookies.get('darkmode');
  
  if( Cookies.get("darkmode") == "true") {
	$('#rdoccss').attr("href", darkModeCsseHref);
}

//  https://cssdeck.com/blog/simple-jquery-stylesheet-switcher/

document.write('<style type="text/css">body{display:none}</style>');

</script>


</head>
<body id="top" role="document" class="class">
  <!-- this is class.html -->

  <div id='actionbar' >
    <div class='wrapper mdiv'>
      <ul class='grids g0'></ul>
    </div> 
    <!-- VERSION HEADER for 3.3.0.preview2 NOT FOUND -->
  </div> <!-- end action bar -->

  <div class='wrapper hdiv'>

    


    <nav id='vapp' role="navigation">
    <div id="project-navigation">
      <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2><a href="../index.html" rel="home">Home</a></h2>

  <div id="table-of-contents-navigation"  >
    <a href="../table_of_contents.html#pages">Pages</a>
    <a href="../table_of_contents.html#classes">Classes</a>
    <a href="../table_of_contents.html#methods">Methods</a>
  </div>
</div>

      <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

    </div>


    
<div class="nav-section">
  <h3>Table of Contents</h3>

  <ul class="link-list" role="directory">
    <li><a href="#class-Net::HTTPRequest-label-Creating+a+Request">Creating a Request</a>
    <li><a href="#class-Net::HTTPRequest-label-Request+Headers">Request Headers</a>
    <li><a href="#class-Net::HTTPRequest-label-Request+Subclasses">Request Subclasses</a>
  </ul>
</div>


    <button id='toggleThing' @click="toggleNav()" >Show/hide navigation</button>
    <div :class="isOpen ? 'block' : 'hidden' " id='toggleMe'>
      <div id="class-metadata">
        
        
<div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  <p class="link"><a href="HTTPGenericRequest.html">Net::HTTPGenericRequest</a>
</div>

        
        
        
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    <li class="calls-super" ><a href="#method-c-new">::new</a>
  </ul>
</div>

      </div>
     </div>
    </nav>


    <div id='extraz'><div class='adzbox-index'  >
      
     </div>         
    </div>

    <main role="main" aria-labelledby="class-Net::HTTPRequest">
    <h1 id="class-Net::HTTPRequest" class="class">
      class Net::HTTPRequest
    </h1>

    <section class="description">
    
<p>This class is the base class for Net::HTTP request classes. The class should not be used directly; instead you should use its subclasses, listed below.</p>

<h2 id="class-Net::HTTPRequest-label-Creating+a+Request">Creating a Request<span><a href="#class-Net::HTTPRequest-label-Creating+a+Request">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>An request object may be created with either a URI or a string hostname:</p>

<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;net/http&#39;</span>
<span class="ruby-identifier">uri</span> = <span class="ruby-constant">URI</span>(<span class="ruby-string">&#39;https://jsonplaceholder.typicode.com/&#39;</span>)
<span class="ruby-identifier">req</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</span>)          <span class="ruby-comment"># =&gt; #&lt;Net::HTTP::Get GET&gt;</span>
<span class="ruby-identifier">req</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Get</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</span>.<span class="ruby-identifier">hostname</span>) <span class="ruby-comment"># =&gt; #&lt;Net::HTTP::Get GET&gt;</span>
</pre>

<p>And with any of the subclasses:</p>

<pre class="ruby"><span class="ruby-identifier">req</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Head</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</span>) <span class="ruby-comment"># =&gt; #&lt;Net::HTTP::Head HEAD&gt;</span>
<span class="ruby-identifier">req</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Post</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</span>) <span class="ruby-comment"># =&gt; #&lt;Net::HTTP::Post POST&gt;</span>
<span class="ruby-identifier">req</span> = <span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">HTTP</span><span class="ruby-operator">::</span><span class="ruby-constant">Put</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">uri</span>)  <span class="ruby-comment"># =&gt; #&lt;Net::HTTP::Put PUT&gt;</span>
<span class="ruby-comment"># ...</span>
</pre>

<p>The new instance is suitable for use as the argument to <a href="HTTP.html#method-i-request"><code>Net::HTTP#request</code></a>.</p>

<h2 id="class-Net::HTTPRequest-label-Request+Headers">Request Headers<span><a href="#class-Net::HTTPRequest-label-Request+Headers">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>A new request object has these header fields by default:</p>

<pre class="ruby"><span class="ruby-identifier">req</span>.<span class="ruby-identifier">to_hash</span>
<span class="ruby-comment"># =&gt;</span>
{<span class="ruby-string">&quot;accept-encoding&quot;</span><span class="ruby-operator">=&gt;</span>[<span class="ruby-string">&quot;gzip;q=1.0,deflate;q=0.6,identity;q=0.3&quot;</span>],
<span class="ruby-string">&quot;accept&quot;</span><span class="ruby-operator">=&gt;</span>[<span class="ruby-string">&quot;*/*&quot;</span>],
<span class="ruby-string">&quot;user-agent&quot;</span><span class="ruby-operator">=&gt;</span>[<span class="ruby-string">&quot;Ruby&quot;</span>],
<span class="ruby-string">&quot;host&quot;</span><span class="ruby-operator">=&gt;</span>[<span class="ruby-string">&quot;jsonplaceholder.typicode.com&quot;</span>]}
</pre>

<p>See:</p>
<ul><li>
<p><a href="https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Accept-Encoding">Request header Accept-Encoding</a> and <a href="HTTP.html#class-Net::HTTP-label-Compression+and+Decompression">Compression and Decompression</a>.</p>
</li><li>
<p><a href="https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#accept-request-header">Request header Accept</a>.</p>
</li><li>
<p><a href="https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#user-agent-request-header">Request header User-Agent</a>.</p>
</li><li>
<p><a href="https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#host-request-header">Request header Host</a>.</p>
</li></ul>

<p>You can add headers or override default headers:</p>

<pre class="ruby"><span class="ruby-comment">#   res = Net::HTTP::Get.new(uri, {&#39;foo&#39; =&gt; &#39;0&#39;, &#39;bar&#39; =&gt; &#39;1&#39;})</span>
</pre>

<p>This class (and therefore its subclasses) also includes (indirectly) module <a href="HTTPHeader.html"><code>Net::HTTPHeader</code></a>, which gives access to its <a href="HTTPHeader.html#module-Net::HTTPHeader-label-Setters">methods for setting headers</a>.</p>

<h2 id="class-Net::HTTPRequest-label-Request+Subclasses">Request Subclasses<span><a href="#class-Net::HTTPRequest-label-Request+Subclasses">&para;</a> <a href="#top">&uarr;</a></span></h2>

<p>Subclasses for HTTP requests:</p>
<ul><li>
<p><a href="HTTP/Get.html"><code>Net::HTTP::Get</code></a></p>
</li><li>
<p><a href="HTTP/Head.html"><code>Net::HTTP::Head</code></a></p>
</li><li>
<p><a href="HTTP/Post.html"><code>Net::HTTP::Post</code></a></p>
</li><li>
<p><a href="HTTP/Put.html"><code>Net::HTTP::Put</code></a></p>
</li><li>
<p><a href="HTTP/Delete.html"><code>Net::HTTP::Delete</code></a></p>
</li><li>
<p><a href="HTTP/Options.html"><code>Net::HTTP::Options</code></a></p>
</li><li>
<p><a href="HTTP/Trace.html"><code>Net::HTTP::Trace</code></a></p>
</li><li>
<p><a href="HTTP/Patch.html"><code>Net::HTTP::Patch</code></a></p>
</li></ul>

<p>Subclasses for WebDAV requests:</p>
<ul><li>
<p><a href="HTTP/Propfind.html"><code>Net::HTTP::Propfind</code></a></p>
</li><li>
<p><a href="HTTP/Proppatch.html"><code>Net::HTTP::Proppatch</code></a></p>
</li><li>
<p><a href="HTTP/Mkcol.html"><code>Net::HTTP::Mkcol</code></a></p>
</li><li>
<p><a href="HTTP/Copy.html"><code>Net::HTTP::Copy</code></a></p>
</li><li>
<p><a href="HTTP/Move.html"><code>Net::HTTP::Move</code></a></p>
</li><li>
<p><a href="HTTP/Lock.html"><code>Net::HTTP::Lock</code></a></p>
</li><li>
<p><a href="HTTP/Unlock.html"><code>Net::HTTP::Unlock</code></a></p>
</li></ul>

    </section>

      <section id="5Buntitled-5D" class="documentation-section">





                <section id="public-class-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Class Methods</h3>
                </header>

                  <div id="method-c-new" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">new</span><span
                                class="method-args">(path, initheader = nil)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Creates an HTTP request object for <code>path</code>.</p>

<p><code>initheader</code> are the default headers to use.  <a href="HTTP.html"><code>Net::HTTP</code></a> adds Accept-Encoding to enable compression of the response body unless Accept-Encoding or Range are supplied in <code>initheader</code>.</p>
                                <div class="method-calls-super">
                                  Calls superclass method
                                  
                              </div>

                              <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File net/http/request.rb, line 82</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">initheader</span> = <span class="ruby-keyword">nil</span>)
  <span class="ruby-keyword">super</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-constant">METHOD</span>,
        <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-constant">REQUEST_HAS_BODY</span>,
        <span class="ruby-keyword">self</span>.<span class="ruby-identifier">class</span><span class="ruby-operator">::</span><span class="ruby-constant">RESPONSE_HAS_BODY</span>,
        <span class="ruby-identifier">path</span>, <span class="ruby-identifier">initheader</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

              </section>
              </main>



            </div>  <!--  class='wrapper hdiv' -->


<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a></p>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.</p>
<p>Based on <a href="https://github.com/ged/darkfish/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>

  
    <p><p><a href="https://ruby-doc.org">Ruby-doc.org</a> is provided by <a href="https://jamesbritt.com">James Britt</a> and <a href="https://neurogami.com">Neurogami</a>. </p><p><a href="https://jamesbritt.bandcamp.com/">Hack your world.  Feed your head.  Live curious</a>.</p>
</p>
  
  </footer>

<script type="text/javascript">


  let ads  = $("#carbonads-container").children().detach();


  function swapMode() {
    var cookieName = 'darkmode';
    var cssDarkmode = Cookies.get(cookieName);
    console.log("***** swapMode! " + cssDarkmode + " *****");


    if (cssDarkmode == "true") {
      console.log("We have dark mode, set the css to light ...");
      $('#rdoccss').attr("href", defaultModeCssHref);
      $('#cssSelect').text("Dark mode");
      cssDarkmode = "false";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    } else {
      console.log("We not have dark mode, set the css to dark ...");
      $('#rdoccss').attr("href", darkModeCsseHref);
      $('#cssSelect').text("Light mode");
      cssDarkmode = "true";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    }

    console.log("  --------------- ");
  }


const vueCssApp = new Vue({
el: '#menubar',
data: {
isDark: false
},
methods: {
toggleClass: function(event){
this.isDark = !this.isDark;
}
}
})

const vueApp = new Vue({
el: '#vapp',
data: { 
isOpen: true
},

mounted() {
this.handleResize();
this.manage_mob_classes();
window.addEventListener('resize', this.handleResize)
//this.isOpen !=  (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},
destroyed() {
window.removeEventListener('resize', this.handleResize)
},
created() {
//manage_mob_classes();
},

methods : {
isMobile() {
  return (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},

  handleResize() {
    if (!this.isMobile()) {
      this.isOpen = window.innerWidth > 800;
    }
  },

  manage_mob_classes() {
    if (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)) {
      $("nav").addClass("mob_nav");
      $("main").addClass("mob_main");
      $("#extraz").addClass("mob_extraz");
      $("#carbonads-container").addClass("mob_carbonads-container");
      this.isOpen  = false;
    } else {
      $("nav").removeClass("mob_nav") 
        $("main").removeClass("mob_main");
      $("#extraz").removeClass("mob_extraz");
      $("#carbonads-container").removeClass("mob_carbonads-container");
      this.isOpen  = true;
    }
  },

  toggleNav() {
    this.isOpen =! this.isOpen ;
    // alert("Toggle nav!");
    console.log("toggleNav() click: " + this.isOpen );
  }
}
})

$("#carbonads-container").append(ads);


$(function() {

    var darkmode = Cookies.get("darkmode");
    console.log("Document ready: " + darkmode);

    if ( darkmode  == "true" ) {
      $('#cssSelect').text("Light mode");
    } else {
      $('#cssSelect').text("Dark mode");
     }

    $('body').css('display','block');
    });

</script>

    
  </body> 
</html>

